# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics do
  @moduledoc """
  Metrics across multiple confidence levels.

  ## Attributes

  *   `auprc` (*type:* `number()`, *default:* `nil`) - The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.
  *   `auprcExact` (*type:* `number()`, *default:* `nil`) - The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.
  *   `confidenceLevelMetrics` (*type:* `list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics.t)`, *default:* `nil`) - Metrics across confidence levels with fuzzy matching enabled.
  *   `confidenceLevelMetricsExact` (*type:* `list(GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics.t)`, *default:* `nil`) - Metrics across confidence levels with only exact matching.
  *   `estimatedCalibrationError` (*type:* `number()`, *default:* `nil`) - The Estimated Calibration Error (ECE) of the confidence of the predicted entities.
  *   `estimatedCalibrationErrorExact` (*type:* `number()`, *default:* `nil`) - The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.
  *   `metricsType` (*type:* `String.t`, *default:* `nil`) - The metrics type for the label.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :auprc => number() | nil,
          :auprcExact => number() | nil,
          :confidenceLevelMetrics =>
            list(
              GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics.t()
            )
            | nil,
          :confidenceLevelMetricsExact =>
            list(
              GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics.t()
            )
            | nil,
          :estimatedCalibrationError => number() | nil,
          :estimatedCalibrationErrorExact => number() | nil,
          :metricsType => String.t() | nil
        }

  field(:auprc)
  field(:auprcExact)

  field(:confidenceLevelMetrics,
    as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics,
    type: :list
  )

  field(:confidenceLevelMetricsExact,
    as: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics,
    type: :list
  )

  field(:estimatedCalibrationError)
  field(:estimatedCalibrationErrorExact)
  field(:metricsType)
end

defimpl Poison.Decoder,
  for: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics do
  def decode(value, options) do
    GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics.decode(
      value,
      options
    )
  end
end

defimpl Poison.Encoder,
  for: GoogleApi.DocumentAI.V1.Model.GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
